Conversation
- Title: replace duplicate-brand `Failproof AI` (rendered as `Failproof AI - FailproofAI`) with keyword-bearing `Introduction — Failure Handling for AI Agents`. Mintlify auto-appends the site name, yielding a single-brand, ~60-char title tag. - Meta description: rewrite 84-char generic line to ~150 chars naming the 39 built-in policies and top failure modes (loops, secret leaks, destructive tool calls). - Body keywords: seed `AI failure handling`, `error recovery`, and `LLM reliability` into the lede; add `agent failure` and `recovery action` to the dashboard sentence so they pick up search signal without keyword stuffing. - CLI list: expand from 3 to the full 7-CLI surface (Claude Code, Codex, Copilot, Cursor, OpenCode, Pi, Gemini, + Agents SDK). - Stale count: card title `26 built-in policies` → `39`, matching `built-in-policies.mdx`. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Sibling fix to the introduction.mdx SEO pass — same stale count appeared in the Builtin policies section of architecture.mdx (`src/hooks/builtin-policies.ts defines all 26 ...`). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR updates docs: introduction hero/overview now emphasizes "Failure Handling for AI Agents" and "39 built-in failure policies," architecture docs reflect 39 policies, docs theme banner/logo were updated to new FailproofAI PNGs, CHANGELOG.md documents the edits, and ChangesDocumentation and Count Corrections
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CHANGELOG.md`:
- Line 6: Append the PR number " (`#366`)" to the end of the changelog entry that
begins "SEO fixes on the docs landing page (`docs/introduction.mdx`): replace
the duplicate-brand title..." so the entry is a single line with the description
followed by the PR number; ensure you do not alter the text otherwise and keep
it as one line.
In `@docs/architecture.mdx`:
- Line 189: Update the stale policy count in the architecture document so both
references match the actual number of built-in policies defined as
BuiltinPolicyDefinition in src/hooks/builtin-policies.ts; locate the two
occurrences that state "39 built-ins" and "26 policy definitions" and change the
incorrect one to the correct total (the actual count of BuiltinPolicyDefinition
entries) so the document is consistent.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: c94a2a4d-87d7-4539-afe5-a80496d3dfdd
📒 Files selected for processing (3)
CHANGELOG.mddocs/architecture.mdxdocs/introduction.mdx
- docs/architecture.mdx: fix the second stale `26 policy definitions` reference in the file tree comment at line 310 (the Builtin policies prose at line 189 was already corrected in 4823f65; the file-tree comment was missed). - CHANGELOG.md: append `(#366)` to the docs entry per changelog format requirement. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Mintlify dev server (`mint dev`) writes a session log at the repo root when started from agent sessions; it should never be committed. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
…banner - Title revert: drop the "Introduction —" prefix per user preference; restore frontmatter title to "Failproof AI" so the H1 reads as just the brand. The keyword density work in the description and body is retained. - Copy pass: remove em dashes from the page body and card subtitles for a less wordy read; rephrase the lede into shorter sentences; drop the "Everything runs locally" line (kept "No data leaves your machine." for the privacy claim). - Description: tighten and remove the "Runs locally." trailing fragment while preserving the 39-policies + failure-modes keyword payload. - Logo: switch docs.json to the FailproofAI wordmark SVGs already shipped in the repo (`logo/light.svg`, `logo/dark.svg`) instead of the Exosphere PNGs. SVGs render the colorful F-mark + failproofai lockup with theme-correct ink colors. - Banner: add a dismissible site-wide Mintlify banner inviting readers to star the GitHub repo. One-line CTA, dismissible. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
User uploaded two new logo PNGs into `docs/logo/`: - `Failproof_AI_logo_light.png` — dark-text wordmark for light-mode UI - `Failproof_AI_logo.png` — light-text wordmark for dark-mode UI Point `docs.json`'s `logo.light` / `logo.dark` at the new files and remove the now-orphaned Exosphere PNGs plus the older stock `light.svg` / `dark.svg` wordmarks that the prior commit had wired up by mistake. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Reads as needy in a developer-doc context. Logo swap stays; the top-of-page CTA goes. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Replace the prior PNGs with the new versions Nivedit dropped into `docs/logo/`. Same filenames, smaller files (`Failproof_AI_logo.png`: 18KB → 14KB; `Failproof_AI_logo_light.png`: 22KB → 10KB). `docs.json` already points at these filenames, so no config change needed. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Untracked asset Nivedit dropped into `docs/` — the colorful F-mark (pink + teal) that pairs with the wordmark logos already in `docs/logo/`. Not wired to `docs.json` `favicon` yet; current favicon stays `/favicon.ico` until told otherwise. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Per user follow-up after the prior commit dropped `docs/icon.svg` in: point `docs.json` favicon at the new vector mark and remove the now orphan `/favicon.ico`. Mintlify renders SVG favicons natively across modern browsers. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Mintlify did not render the SVG favicon in the live preview. Nivedit dropped a 32x32 32-bit `docs/favicon.ico` into the docs root; point `docs.json` `favicon` at `/favicon.ico` and remove the now unused `docs/icon.svg`. Also picks up another `Failproof_AI_logo.png` refresh. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Originally an SEO fix on
docs.befailproof.ai/introduction(title, meta description, H1, keyword coverage); during local Mintlify preview the scope expanded into a small copy + branding pass on the same page.Page copy (
docs/introduction.mdx)Failproof AI(per user preference; an earlier "Introduction — Failure Handling for AI Agents" version was reverted). The frontmatterdescriptionkeeps the keyword payload.AI failure handling,error recovery,LLM reliabilityadded to the lede;agent failureandrecovery actionadded to the dashboard sentence. Audit flagged all three as 0-occurrence on the page; they now appear naturally without keyword stuffing.26 built-in policies→39 built-in policies, matchingdocs/built-in-policies.mdxline 7.Sibling fixes in
docs/architecture.mdxSame stale
26count was in two places. Both corrected:defines all 26 …→defines all 39 ….# 26 policy definitions→# 39 policy definitions.Branding (
docs/docs.json,docs/logo/,docs/favicon.ico)logo/exosphere-{light,dark}.png). Replaced with the user-uploaded FailproofAI wordmark PNGs:logo/Failproof_AI_logo_light.png(dark text, for light-mode UI) andlogo/Failproof_AI_logo.png(light text, for dark-mode UI). The unusedlogo/light.svg,logo/dark.svg, and the Exosphere PNGs are removed from disk. PNGs got re-exported to smaller versions during iteration.docs/icon.svgfavicon in live preview, so Nivedit dropped a 32x32 32-bitdocs/favicon.ico.docs.jsonfavicon path settled on/favicon.ico; the SVG asset is removed.i18n
The 16 localized
docs/<lang>/introduction.mdxfiles are not edited here. The.github/workflows/translate-docs.ymlworkflow watchesdocs/*.mdxanddocs/**/*.mdx, so on push it auto-translates the English changes into every language.Repo hygiene
mint-dev.logwas added to.gitignoreso the Mintlify local-preview log doesn't slip into future commits.Commit map
82ebceeintroduction.mdx(title, desc, keywords, CLI list, count).4823f6526 → 39fix inarchitecture.mdxprose.dbc83f826in file-tree comment +(#366)on changelog line.e258f27.gitignoreignoresmint-dev.log.579ec4bFailproof AI, em-dash + "Runs locally" copy polish, initial logo wiring, star-us banner (reverted).f87538d500ba78985cbb2969dee3docs/icon.svg(FailproofAI F-mark) as an asset.c9120d5docs.jsonfavicon to/icon.svgand remove the old/favicon.ico.abc8ff9favicon.ico, drop the SVG attempt, pick up another logo refresh.Test plan
/introductionshows the title in the browser tab asFailproof AI - FailproofAI(per Mintlify auto-append).<meta name="description">matches the rewritten string and contains39 built-in failure policies.Failproof AI.39 built-in policies.AI failure handling,error recovery, andLLM reliability.—) and no "Everything runs locally" sentence.39.docs/favicon.ico).translate-docsjob runs green on push and opens the auto-translation PR for the 16 locales.🤖 Generated with Claude Code